<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.grid3d.Grid3D</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        <a href="py2ecotect.doc.grid3d-module.html">Module&nbsp;grid3d</a> ::
        Class&nbsp;Grid3D
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.grid3d.Grid3D-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Grid3D</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Grid3D</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
      This method deletes current 3D data and frees all associated memory.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#getframe" class="summary-sig-name">getframe</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span><br />
      Use this method to get frames within the 3D data grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.getframe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#initialise" class="summary-sig-name">initialise</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Use this command to allocate memory for the 3D analysis space.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.initialise">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#reset" class="summary-sig-name">reset</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Use this method to reset all 3D grid values back to 0.0.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.reset">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#setframe" class="summary-sig-name">setframe</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Use this method to set frames within the 3D data grid.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.setframe">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#set_blockage" class="summary-sig-name">set_blockage</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>,
        <span class="summary-sig-arg">state</span>)</span><br />
      Sets the CFD blockage flag of the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_blockage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_cell" class="summary-sig-name">get_cell</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Retrieves the value stored in the specified 3D grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_cell">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#set_cell" class="summary-sig-name">set_cell</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>,
        <span class="summary-sig-arg">value</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Sets the value stored in the specified 3D grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_cell">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_index" class="summary-sig-name">get_index</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>)</span><br />
      Returns the i, j, k index of the specified 3D world coordinate given 
      by the x, y, z parameters.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_index">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_position" class="summary-sig-name">get_position</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>)</span><br />
      Returns the x, y and z coordinate of the grid node given by the i, i,
      k parameters.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_position">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_state" class="summary-sig-name">get_state</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>)</span><br />
      Retrieves the state of the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_state">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#set_state" class="summary-sig-name">set_state</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>,
        <span class="summary-sig-arg">state</span>)</span><br />
      Sets the state of the specified grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_state">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_value" class="summary-sig-name">get_value</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">absolute_position</span>,
        <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">0</span>)</span><br />
      Returns the interpolated value for the point given by the x, y, z 3D 
      world coordinates.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_value">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#get_vector" class="summary-sig-name">get_vector</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">cell_index</span>)</span><br />
      Retrieves the vector value stored in the specified 3D grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_vector">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.grid3d.Grid3D-class.html#set_vector" class="summary-sig-name">set_vector</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">i</span>,
        <span class="summary-sig-arg">j</span>,
        <span class="summary-sig-arg">k</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Sets the vector value for the specified 3D grid cell.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_vector">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>This method deletes current 3D data and frees all associated memory. 
  It does not affect the current 2D analysis grid object.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="getframe"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">getframe</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.getframe">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this method to get frames within the 3D data grid. When used in 
  this way, the third dimension of the 3D grid becomes an animation buffer 
  for the 2D grid. The 2D grid remains in the same relative position as 
  frames are copied from the frame buffer. This can be useful if you need 
  to directly compare results from a range of calculations carried out 
  under different conditions.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>index Specifies which frame number to retrieve. The maximum number of 
  frames in the buffer is equal to the size of the 3D grid in the current 
  axis. Obvously, if you fill up the 3D frame buffer and then change the 
  current axis of the 2D grid, you will get invalid 2D results.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="initialise"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">initialise</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.initialise">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this command to allocate memory for the 3D analysis space. The 
  size of the 3D grid and the number of cells is given as part of the 2D 
  analysis grid object.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reset"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reset</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.reset">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this method to reset all 3D grid values back to 0.0.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="setframe"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setframe</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.setframe">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Use this method to set frames within the 3D data grid. When used in 
  this way, the third dimension of the 3D grid becomes an animation buffer 
  for the 2D grid. The 2D grid remains in the same relative position as 
  frames are copied to the frame buffer. This can be useful if you need to 
  directly compare results from a range of calculations carried out under 
  different conditions.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>index Specifies which frame number to set. The maximum number of 
  frames in the buffer is equal to the size of the 3D grid in the current 
  axis. Obvously, if you fill up the 3D frame buffer and then change the 
  current axis of the 2D grid, you will end up with invalid 2D results.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_blockage"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_blockage</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>,
        <span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_blockage">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the CFD blockage flag of the specified grid cell. When in CFD 
  mode, the state value of each 3D grid cell stores information about 
  boundary conditions within the model, instead of the values outlined in 
  the get.grid3d.state property.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>state An integer value for the configuration of the blockage flag, as 
  outlined in the following Grid Blockage Options table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Blockage Options Value Description 1 Cell blocked (set 
  automatically during calculation). 2 Surface passes though cell (set 
  during calculation). 4 Pressure boundary at cell (set during 
  calculation). 8 Heat gains in cell (set during calculation). 16 Air 
  outflow in cell (set during calculation). 32 Air intflow in cell (set 
  during calculation). 64 Contaminant gains in cell (set during 
  calculation). 128 Cell contains a WINDOW object (set during calculation).
  256 Cell contains a VOID (set during calculation). 512 USED INTERNALLY 
  FOR TEMPORARY FLAG 1024 Cell should be blocked no matter what is in 
  it.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_cell"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_cell</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_cell">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the value stored in the specified 3D grid cell. Getting this
  property returns two values. The first is the actual value of the cell in
  the current units, while the second is the state of the 3D cell, whether 
  it is hidden or has been interactively selected by the user.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>[index] Each 3D grid cell has up to 3 different slots for storing 
  values. The optional [index] parameter specifies which particular slot 
  this value should be retrieved and can be 0, 1 or 2. If not specified, 
  the currently selected index is used.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value The value stored within the specified grid cell.</p>
  <p>state the state of the specified grid cell. The possible values 
  returned are shown in the following Grid Cell State Codes table.</p>
  <p>Relevant Data Table(s) Grid Cell State Codes Value Description 1 
  Visible and selected. 0 Visible but not selected. -99 Disabled. -100 
  Hidden. -100 Hidden and selected.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_cell"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_cell</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>,
        <span class="sig-arg">value</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_cell">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the value stored in the specified 3D grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>value The value to be stored within the specified grid cell.</p>
  <p>[index] Each 3D grid cell has up to 3 different slots for storing 
  values. The optional [index] parameter specifies which particular slot 
  this value should be stored in and can be 0, 1 or 2. If not specified, 
  the currently displayed index is used.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_index"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_index</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">absolute_position</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_index">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the i, j, k index of the specified 3D world coordinate given 
  by the x, y, z parameters. This function is necessary because the spacing
  between cells in each axis can be set to any value by the user. In 
  addition to the i, j, k values returned is a boolean (0 or 1) value 
  specifying if the point is actually within the bounded grid volume. Thus,
  before using the i, j, k indexes, first check they are valid, as shown in
  the example code.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represent the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>i, j, k The 3D index of a cell within the analysis grid. Each is an 
  integer between 0 and the current grid size - 1 in the relevant grid 
  axis.</p>
  <p>valid A boolean (0 or 1) value specifying if the node is actually 
  within the bounded grid volume.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_position"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_position</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_position">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the x, y and z coordinate of the grid node given by the i, i, 
  k parameters. This function is necessary because the spacing between 
  cells in each axis can be set to any value by the user.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>x, y, z Represents the absolute position in the X, Y and Z axis of the
  grid node in 3 dimensional model space.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_state"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_state</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_state">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the state of the specified grid cell. The state of a 3D cell
  stores whether it is hidden or has been interactively selected by the 
  user.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>state the state of the specified grid cell. The possible values 
  returned are shown in the following Grid Cell State Codes table.</p>
  <p>Relevant Data Table(s) Grid Cell State Codes Value Description 1 
  Visible and selected. 0 Visible but not selected. -99 Disabled. -100 
  Hidden. -100 Hidden and selected</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_state"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_state</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>,
        <span class="sig-arg">state</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_state">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the state of the specified grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>state Determines if the cell is hidden or not, and if it has been 
  interactively selected by the user. The range of possible values are 
  given in the following Grid Cell State Codes table.</p>
  <p>Relevant Data Table(s)</p>
  <p>Grid Cell State Codes Value Description 1 Visible and selected. 0 
  Visible but not selected. -99 Disabled. -100 Hidden. -100 Hidden and 
  selected.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_value"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_value</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">absolute_position</span>,
        <span class="sig-arg">index</span>=<span class="sig-default">0</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_value">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Returns the interpolated value for the point given by the x, y, z 3D 
  world coordinates. This function is necessary because the spacing between
  cells in each axis can be set to any value by the user. In addition to 
  the value returned is a boolean (0 or 1) value specifying if the point is
  actually within the bounded grid volume. Thus, before using the value, 
  first check it is valid, as shown in the example code.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>absolute_position A list of three values that represent the absolute 
  position in the X, Y and Z axis of a point in 3 dimensional model 
  space.</p>
  <p>[index] Each grid cell has up to 3 slots to store different values. 
  The optional [index] parameter specifies which particular slot value to 
  retrieve, and can be 0, 1 or 2. If the [index] parameter is not 
  specified, the currently displayed index is used by default.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value The interpolated value stored within the grid cell.</p>
  <p>valid A boolean (0 or 1) value specifying if the node is actually 
  within the bounded grid volume.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_vector"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_vector</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">cell_index</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.get_vector">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the vector value stored in the specified 3D grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>cell_index A list of three values that represent the 3D index of a 
  cell within the analysis grid. Each must be an integer between 0 and the 
  current grid size - 1 in the relevant grid axis.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>dx, dy, dz A value representing the offset distance in each of the X, 
  Y and Z axis, given in model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_vector"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_vector</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">i</span>,
        <span class="sig-arg">j</span>,
        <span class="sig-arg">k</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.grid3d-pysrc.html#Grid3D.set_vector">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the vector value for the specified 3D grid cell.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>i, j, k The 3D index of a cell within the analysis grid. Each must be 
  an integer between 0 and the current grid size - 1 in the relevant grid 
  axis.</p>
  <p>offset_distance A list of three values that represent the offset 
  distance in each of the X, Y and Z axis, given in model coordinates.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
